﻿/*
 * Copyright (c) 2015-2016 Constantijn Evenhuis (blueprints@const.nl)
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
using System;

namespace Blueprints
{
    /// <summary>
    /// The result of deserialization.
    /// </summary>
    public enum DeserializationResult
    {
        /// <summary>
        /// The status of the node is unknown. 
        /// </summary>
        Unknown,

        /// <summary>
        /// Indicates that the node was deserialized successfully.
        /// </summary>
        Success,

        /// <summary>
        /// Indicates that the type could not be found.
        /// </summary>
        TypeUnknown,

        /// <summary>
        /// Indicates that the type is not compatible with the expected type.
        /// </summary>
        TypeNotCompatible,

        /// <summary>
        /// Indicates that the type is not a concrete type.
        /// </summary>
        TypeNotInstantiable,

        /// <summary>
        /// Indicates that the link is from an non-"file://" uri to a "file://" uri, which is not allowed.
        /// </summary>
        LinkNotAllowed,

        /// <summary>
        /// Indicates that the linked node could not be deserialized.
        /// </summary>
        LinkError,

        /// <summary>
        /// Indicates that the linked node is not compatible with the node linking to it.
        /// </summary>
        LinkNotCompatible,

        /// <summary>
        /// Indicates that one or more required properties are missing.
        /// </summary>
        MissingRequiredProperty,

        /// <summary>
        /// Indicates that the value cannot be cast into the destination type.
        /// </summary>
        InvalidValue,

        /// <summary>
        /// The node was deserialized successfully, but a descendant node did not.
        /// </summary>
        DescendantFailed,
    }
}